Snap to Road

Find the nearest road point to given coordinates. Returns snapped coordinates and distance to road. Use for vehicle tracking, GPS trace alignment, and ride-sharing location accuracy.

Usage

import { createBarikoiClient } from "barikoiapis";

const barikoi = createBarikoiClient({
  apiKey: "YOUR_BARIKOI_API_KEY",
});

const result = await barikoi.snapToRoad({
  point: "23.8103,90.4125", // Format: latitude,longitude
});

const snapped = result.data?.coordinates;
const distance = result.data?.distance;

Response

This API returns:

coordinates (snapped point), distance (in meters), type

Parameters

Parameter	Type	Description
point	string	Required. Coordinates in format: latitude,longitude

Example

const result = await barikoi.snapToRoad({
  point: "23.8103,90.4125",
});

const snappedCoordinates = result.data?.coordinates;
const distanceToRoad = result.data?.distance;

if (snappedCoordinates) {
  console.log(`Original: 23.8103, 90.4125`);
  console.log(`Snapped: ${snappedCoordinates[1]}, ${snappedCoordinates[0]}`);
  console.log(`Distance to nearest road: ${distanceToRoad}m`);
}

Type Definitions

export type SnapToRoadParams = {
  point: string; // Format: latitude,longitude
};

export type SnapToRoadSuccess = {
  coordinates?: [number, number];
  /**
   * Distance in meters
   */
  distance?: number;
  type?: "Point";
};